#!/usr/bin/env python
# -*- coding:utf-8 -*-
# @FileName  :decorator.py
# @Time      :2021/3/22 16:06
# @Author    :Letquit
"""
文件说明：装饰器

"""
# 由于函数也是一个对象，而且函数对象可以被赋值给变量，所以，通过变量也能调用该函数
def now():
    print('2021-03-22')
f = now()
# f()    # 'NoneType' object is not callable
f
# 函数对象有一个__name__属性，可以拿到函数的名字
print(now.__name__)
# print(f.__name__)    # 'NoneType' object is not callable
# 现在，假设我们要增强now()函数的功能，比如，在函数调用前后自动打印日志，但又不希望修改now()函数的定义，
# 这种在代码运行期间动态增加功能的方式，称之为“装饰器”（Decorator）。
# 本质上，decorator就是一个返回函数的高阶函数。所以，我们要定义一个能打印日志的decorator，可以定义如下
def log(func):
    def wrapper(*args, **kw):
        print('call %s():' % func.__name__)
        return func(*args, **kw)
    return wrapper

# 观察上面的log，因为它是一个decorator，所以接受一个函数作为参数，并返回一个函数。
# 我们要借助Python的@语法，把decorator置于函数的定义处
@log
def tomorrow():    # now = log(now)
    print('2021-03-23')
t = tomorrow()
# 调用now()函数，不仅会运行now()函数本身，还会在运行now()函数前打印一行日志
# 把@log放到now()函数的定义处，相当于执行了语句
# 由于log()是一个decorator，返回一个函数，所以，原来的now()函数仍然存在，
# 只是现在同名的now变量指向了新的函数，于是调用now()将执行新函数，即在log()函数中返回的wrapper()函数
# wrapper()函数的参数定义是(*args, **kw)，因此，wrapper()函数可以接受任意参数的调用。
# 在wrapper()函数内，首先打印日志，再紧接着调用原始函数
# 如果decorator本身需要传入参数，那就需要编写一个返回decorator的高阶函数，写出来会更复杂。
# 比如，要自定义log的文本
def log1(text):
    def decorator(func):
        def wrapper1(*args, **kw):
            print('%s %s():' % (text, func.__name__))
            return func(*args, **kw)
        return wrapper1
    return decorator
# 这个3层嵌套的decorator用法如下
@log1('execute')
def yesterday():    # yesterday = log('execute')(yesterday)
    print('2015-3-25')
yesterday()
# 和两层嵌套的decorator相比，3层嵌套的效果是这样的
# 我们来剖析上面的语句，首先执行log('execute')，返回的是decorator函数，再调用返回的函数，
# 参数是yesterday函数，返回值最终是wrapper1函数
# 以上两种decorator的定义都没有问题，但还差最后一步。因为我们讲了函数也是对象，
# 它有__name__等属性，但你去看经过decorator装饰之后的函数，它们的__name__已经从原来的'yesterday‘变成了’wrapper1'
print(yesterday.__name__)
# 因为返回的那个wrapper1()函数名字就是'wrapper1'，
# 所以，需要把原始函数的__name__等属性复制到wrapper1()函数中，否则，有些依赖函数签名的代码执行就会出错
# 不需要编写wrapper1.__name__ = func.__name__这样的代码，Python内置的functools.wraps就是干这个事的，
# 所以，一个完整的decorator的写法如下
import functools

def log(func):
    @functools.wraps(func)
    def wrapper(*args, **kw):
        print('call %s():' % func.__name__)
        return func(*args, **kw)
    return wrapper
@log
def now():
    print('15:23')
now()
print(now.__name__)
# 或者针对带参数的decorator
import functools

def log(text):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kw):
            print('%s %s():' % (text, func.__name__))
            return func(*args, **kw)
        return wrapper
    return decorator
@log('it call')
def now():
    print('15:23')
now()
print(now.__name__)
# import functools是导入functools模块。
# 现在，只需记住在定义wrapper()的前面加上@functools.wraps(func)即可

# 练习
# 请设计一个decorator，它可作用于任何函数上，并打印该函数的执行时间：
import time, functools

def metric(fn):
    @functools.wraps(fn)
    def wrapper(*args, **kw):
        start = time.time()    # 开始时间
        method = fn(*args, **kw)    # 方法
        end = time.time()    # 结束时间
        print('%s executed in %s ms' % (fn.__name__, end - start))
        return method
    return wrapper

# 测试
@metric
def fast(x, y):
    time.sleep(0.0012)
    return x + y;

@metric
def slow(x, y, z):
    time.sleep(0.1234)
    return x * y * z;

f = fast(11, 22)
s = slow(11, 22, 33)
if f != 33:
    print('测试失败!')
elif s != 7986:
    print('测试失败!')
else:
    print('测试成功!')

# 小结
# 在面向对象（OOP）的设计模式中，decorator被称为装饰模式。
# OOP的装饰模式需要通过继承和组合来实现，而Python除了能支持OOP的decorator外，直接从语法层次支持decorator。
# Python的decorator可以用函数实现，也可以用类实现。
# decorator可以增强函数的功能，定义起来虽然有点复杂，但使用起来非常灵活和方便。
# 请编写一个decorator，能在函数调用的前后打印出'begin call'和'end call'的日志。
# 再思考一下能否写出一个@log的decorator，使它既支持：
# @log
# def f():
#     pass
# 又支持：
# @log('execute')
# def f():
#     pass
import functools
def log(temp):
    if not isinstance(temp,str):
        # 使用decorator后,func指向log(func)
        # 将更名后的'__name__'更改回原函数名称防止签名错误
        @functools.wraps(temp)
        def wrapper(*args,**kw):
            # operations
            return temp(*args,**kw)
        return wrapper
    else:    # 此时temp为一串str参数
        # new decorator
        def decorator(func):
            @functools.wraps(func)
            def wrapper(*args,**kw):
                print(temp)    # 打印字符串temp
                # operations
                return func(*args,**kw)
            return wrapper
        return decorator
# https://blog.csdn.net/weixin_39330979/article/details/81513021?utm_source=blogxgwz2

if __name__ == "__main__":
    run_code = 0
